package cn.zyl.demo.common.gif;

import java.net.*;
import java.io.*;
import java.util.*;
import java.awt.*;
import java.awt.image.*;
/**
 * GIFDecoder类说明: 处理GIF图片
 * <a href="https://blog.csdn.net/haige807/article/details/83740012">GIFDecoder.java源程序</a>
 * @author wsz
 * @version v1.0
 * @date 2020-08-19
 */
public class GifDecoder {
    /**文件读取状态：无错误*/
    public static final int STATUS_OK = 0;
    /**文件读取状态：解码文件时出错（可能已部分解码）*/
    public static final int STATUS_FORMAT_ERROR = 1;
    /** 文件读取状态：无法打开源代码。*/
    public static final int STATUS_OPEN_ERROR = 2;
    /** 最大解码器像素堆栈大小*/
    protected static final int MAX_STACK_SIZE = 4096;
    private static final String GIF_STR = "GIF";

    protected BufferedInputStream in;
    protected int status;
    /** 全图像宽度*/
    protected int width;
    /** 全图像高度*/
    protected int height;
    /** 使用的全局色表*/
    protected boolean gctFlag;
    /** 全局色表的大小*/
    protected int gctSize;
    /** 迭代； 0 =永远重复*/
    protected int loopCount = 1;
    /** 全局色表*/
    protected int[] gct;
    /** 本地色表*/
    protected int[] lct;
    /** 活动色表*/
    protected int[] act;
    /** 背景色指数*/
    protected int bgIndex;
    /** 背景颜色*/
    protected int bgColor;
    /** 先前的背景色*/
    protected int lastBgColor;
    /** 像素长宽比*/
    protected int pixelAspect;
    /** 本地颜色表标志*/
    protected boolean lctFlag;
    /** 隔行标志*/
    protected boolean interlace;
    /** 本地色表大小*/
    protected int lctSize;
    /** 当前图像矩形*/
    protected int ix, iy, iw, ih;
    /** 最后一张图片*/
    protected Rectangle lastRect;
    /** 当前帧*/
    protected BufferedImage image;
    /** 前一帧*/
    protected BufferedImage lastImage;
    /** 当前数据块*/
    protected byte[] block = new byte[256];
    /** 块大小*/
    protected int blockSize = 0;
    /** 上次图形控件扩展信息*/
    protected int dispose = 0;
    /** 0=无操作；1=保留原位；2=还原到背景；3=还原到上一个*/
    protected int lastDispose = 0;
    /** 使用透明的颜色*/
    protected boolean transparency = false;
    /** 延迟毫秒*/
    protected int delay = 0;
    /** 透明指数*/
    protected int transIndex;
    /** LZW解码器工作阵列*/
    protected short[] prefix;
    protected byte[] suffix;
    protected byte[] pixelStack;
    protected byte[] pixels;
    /** 从当前文件读取的帧*/
    protected ArrayList<GifFrame> frames;
    /** 图像总帧数*/
    protected int frameCount;

    static class GifFrame {
        public final BufferedImage image;
        public final int delay;
        public GifFrame(BufferedImage im, int del) { image = im;delay = del; }
    }

    /**
     * 获取从文件读取的帧数。
     * @return 帧数
     */
    public int getFrameCount() {
        return frameCount;
    }
    /**
     * 获取第n帧的图像内容。
     * @return 帧的BufferedImage表示形式；如果n无效，则为null。
     */
    public BufferedImage getFrame(int n) { return validFrameIndex(n) ? frames.get(n).image : null; }
    /**
     * 获取指定帧的显示持续时间。
     * @param n 帧的int索引
     * @return 延迟毫秒
     */
    public int getDelay(int n) {
        delay = validFrameIndex(n) ? frames.get(n).delay : -1;
        return delay;
    }
    /**
     * 获取读取的第一个（或唯一）图像。
     * @return BufferedImage包含第一帧；如果没有，则为null。
     */
    public BufferedImage getImage() {
        return getFrame(0);
    }
    /**
     * 获取“Netscape”迭代计数（如果有）。计数为0表示不确定地重复。
     * @return 如果指定了一个，则为迭代计数，否则为1。
     */
    public int getLoopCount() {
        return loopCount;
    }
    /**
     * 获取图像大小。
     * @return GIF图片尺寸
     */
    public Dimension getFrameSize() {
        return new Dimension(width, height);
    }
    /**
     * 从流中读取GIF图像
     *
     * @param is 包含GIF文件。
     * @return 读取状态码（0 =无错误）
     */
    public int read(BufferedInputStream is) { return readStream(is); }
    /**
     * 从流中读取GIF图像
     * @param is 包含GIF文件。
     * @return 读取状态码（0 =无错误）
     */
    public int read(InputStream is) { return readStream(is); }
    /**
     * 从指定的文件/ URL来源读取GIF文件（如果名称包含“：/”或“ file：”，则假定为URL）
     * @param name 字符串包含源
     * @return 读取状态码（0 =无错误）
     */
    public int read(String name) { return readStream(name); }
    //--------------------私有的函数------------------
    /**
     * 从指定的文件/ URL来源读取GIF文件（如果名称包含“：/”或“ file：”，则假定为URL）
     * @param name 字符串包含源
     * @return 读取状态码（0 =无错误）
     */
    private int readStream(String name){
        try {
            status = STATUS_OK;
            name = name.trim().toLowerCase();
            if (name.contains("file:") || name.contains(":/")) {
                return readStream(new BufferedInputStream(new URL(name).openStream()));
            }
            return readStream(new BufferedInputStream(new FileInputStream(name)));
        } catch (IOException e) {
            status = STATUS_OPEN_ERROR;
        }
        return status;
    }
    /**
     * 从流中读取GIF图像
     * @param is 包含GIF文件。
     * @return 读取状态码（0 =无错误）
     */
    private int readStream(InputStream is){
        init();
        if( null == is){
            status = STATUS_OPEN_ERROR;
            return status;
        }
        if (!(is instanceof BufferedInputStream)) {
            is = new BufferedInputStream(is);
        }
        in = (BufferedInputStream) is;
        readHeader();
        if (!err()) {
            readContents();
            if (frameCount < 0) {
                status = STATUS_FORMAT_ERROR;
            }
        }
        try {
            is.close();
        } catch (IOException e) {
            status = STATUS_OPEN_ERROR;
        }
        return status;
    }
    /**
     * 判断第n帧是否有效
     * @param n 帧的int索引
     * @return n大于等于0，小于总帧数，有效；否则无效
     */
    private boolean validFrameIndex(int n){ return n >= 0 && n < frameCount;}

    //--------------------受保护方法---------------
    /**
     * 根据当前数据（以及先前的帧，由其处置代码指定）创建新的帧图像。
     */
    protected void setPixels() {
        // 将目标图像的像素公开为int数组
        int[] dest = ((DataBufferInt) image.getRaster().getDataBuffer()).getData();
        // 根据最后一张图像的处理代码填写起始图像内容
        if (lastDispose > 0) {
            if (lastDispose == 3) {
                // 最后使用图像
                int n = frameCount - 2;
                if (n > 0) {
                    lastImage = getFrame(n - 1);
                } else {
                    lastImage = null;
                }
            }
            if (lastImage != null) {
                int[] prev = ((DataBufferInt) lastImage.getRaster().getDataBuffer()).getData();
                System.arraycopy(prev, 0, dest, 0, width * height);
                // 复制像素
                if (lastDispose == 2) {
                    // 用背景色填充最后一个图像区域
                    Graphics2D g = image.createGraphics();
                    Color c;
                    if (transparency) {
                        // 假设背景是透明的
                        c = new Color(0, 0, 0, 0);
                    } else {
                        // 使用给定的背景色
                        c = new Color(lastBgColor);
                    }
                    g.setColor(c);
                    // 更换区域
                    g.setComposite(AlphaComposite.Src);
                    g.fill(lastRect);
                    g.dispose();
                }
            }
        }
        // 将每个源代码行复制到目标位置中的适当位置
        int pass = 1;
        int inc = 8;
        int iline = 0;
        for (int i = 0; i < ih; i++) {
            int line = i;
            if (interlace) {
                if (iline >= ih) {
                    pass++;
                    switch (pass) {
                        case 2 :
                            iline = 4;
                            break;
                        case 3 :
                            iline = 2;
                            inc = 4;
                            break;
                        default :
                            iline = 1;
                            inc = 2;
                    }
                }
                line = iline;
                iline += inc;
            }
            line += iy;
            if (line < height) {
                int k = line * width;
                // 目标行的开始
                int dx = k + ix;
                // 目的地行结束
                int dlim = dx + iw;
                if ((k + width) < dlim) {
                    // 越过目的地边缘
                    dlim = k + width;
                }
                // 源代码行的开始
                int sx = i * iw;
                while (dx < dlim) {
                    // 映射颜色并插入目的地
                    int index = ((int) pixels[sx++]) & 0xff;
                    int c = act[index];
                    if (c != 0) {
                        dest[dx] = c;
                    }
                    dx++;
                }
            }
        }
    }
    /**
     * 将LZW图像数据解码为像素阵列。改编自John Cristy的ImageMagick。
     */
    protected void decodeImageData() {
        int nullCode = -1;
        int nPix = iw * ih;
        // 分配新的像素数组
        if ((pixels == null) || (pixels.length < nPix)) {
            pixels = new byte[nPix];
        }
        if (prefix == null) {
            prefix = new short[MAX_STACK_SIZE];
        }
        if (suffix == null) {
            suffix = new byte[MAX_STACK_SIZE];
        }
        if (pixelStack == null) {
            pixelStack = new byte[MAX_STACK_SIZE + 1];
        }
        //初始化GIF数据流解码器。
        int dataSize = read();
        int clear = 1 << dataSize;
        int endOfInformation = clear + 1;
        int available = clear + 2;
        int oldCode = nullCode;
        int codeSize = dataSize + 1;
        int codeMask = (1 << codeSize) - 1;

        int inCode,  bits, code, count, datum, first, top, bi, pi;
        for (code = 0; code < clear; code++) {
            prefix[code] = 0;
            suffix[code] = (byte) code;
        }
        //解码GIF像素流。
        datum = bits = count = first = top = pi = bi = 0;
        for (int i = 0; i < nPix;i++) {
            if (top == 0) {
                if (bits < codeSize) {
                    //加载字节，直到有足够的位数来存储代码为止。
                    if (count == 0) {
                        //读取一个新的数据块。
                        count = readBlock();
                        if (count <= 0) {
                            break;
                        }
                        bi = 0;
                    }
                    datum += (((int) block[bi]) & 0xff) << bits;
                    bits += 8;
                    bi++;
                    count--;
                    continue;
                }
                //获取下一个字节码
                code = datum & codeMask;
                datum >>= codeSize;
                bits -= codeSize;
                //解读字节码
                if ((code > available) || (code == endOfInformation)) {
                    break;
                }
                if (code == clear) {
                    //重置解码器
                    codeSize = dataSize + 1;
                    codeMask = (1 << codeSize) - 1;
                    available = clear + 2;
                    oldCode = nullCode;
                    continue;
                }
                if (oldCode == nullCode) {
                    pixelStack[top++] = suffix[code];
                    oldCode = code;
                    first = code;
                    continue;
                }
                inCode = code;
                if (code == available) {
                    pixelStack[top++] = (byte) first;
                    code = oldCode;
                }
                while (code > clear) {
                    pixelStack[top++] = suffix[code];
                    code = prefix[code];
                }
                first = ((int) suffix[code]) & 0xff;
                //  将新的字符串添加到字符串表
                if (available >= MAX_STACK_SIZE) {
                    break;
                }
                pixelStack[top++] = (byte) first;
                prefix[available] = (short) oldCode;
                suffix[available] = (byte) first;
                available++;
                if (((available & codeMask) == 0)
                        && (available < MAX_STACK_SIZE)) {
                    codeSize++;
                    codeMask += available;
                }
                oldCode = inCode;
            }
            // 从像素堆栈弹出一个像素。
            top--;
            pixels[pi++] = pixelStack[top];
        }
        for (int i = pi; i < nPix; i++) {
            //清除丢失的像素
            pixels[i] = 0;
        }
    }
    /**
     * 如果在读取/解码期间遇到错误，则返回true
     */
    protected boolean err() { return status != STATUS_OK; }
    /**
     * 初始化或重新初始化阅读器
     */
    protected void init() {
        status = STATUS_OK;
        frameCount = 0;
        frames = new ArrayList<>();
        gct = null;
        lct = null;
    }
    /**
     * 从输入流中读取一个字节。
     */
    protected int read() {
        try {
            return in.read();
        } catch (IOException e) {
            status = STATUS_FORMAT_ERROR;
        }
        return 0;
    }
    /**
     * 从输入中读取下一个可变长度块。
     *
     * @return “缓冲区”中存储的字节数
     */
    protected int readBlock() {
        blockSize = read();
        int n = 0;
        if (blockSize > 0) {
            try {
                int count;
                while (n < blockSize) {
                    count = in.read(block, n, blockSize - n);
                    if (count == -1) { break; }
                    n += count;
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
            if (n < blockSize) {
                status = STATUS_FORMAT_ERROR;
            }
        }
        return n;
    }
    /**
     * 将颜色表读取为256个RGB整数值
     *
     * @param colors int 读取的颜色数
     * @return 包含256种颜色的int数组（带有完整alpha的压缩ARGB）
     */
    protected int[] readColorTable(int colors) {
        int bytes = 3 * colors;
        byte[] c = new byte[bytes];
        int n = 0;
        try {
            n = in.read(c);
        } catch (IOException e) {
            e.printStackTrace();
        }
        if (n < bytes) {
            status = STATUS_FORMAT_ERROR;
            return null;
        }
        //避免边界检查的最大尺寸
        int[] tab = new int[256];
        int i = 0,j = 0;
        while (i < colors) {
            int r = ((int) c[j++]) & 0xff;
            int g = ((int) c[j++]) & 0xff;
            int b = ((int) c[j++]) & 0xff;
            tab[i++] = 0xff000000 | (r << 16) | (g << 8) | b;
        }
        return tab;
    }
    /**
     * 主文件解析器。读取GIF内容块。
     */
    protected void readContents() {
        //读取GIF文件内容块
        boolean done = false;
        while (!(done || err())) {
            int code = read();
            switch (code) {
                case 0x2C :
                    //图像分离器
                    readImage();
                    break;
                case 0x21 :
                    //扩展
                    code = read();
                    switch (code) {
                        case 0xf9 :
                            //图形控件扩展
                            readGraphicControlExt();
                            break;
                        case 0xff :
                            //应用扩展
                            readBlock();
                            StringBuilder app = new StringBuilder();
                            for (int i = 0; i < 11; i++) {
                                app.append((char) block[i]);
                            }
                            if ("NETSCAPE2.0".equals(app.toString())) {
                                readNetscapeExt();
                            } else {
                                //不在乎
                                skip();
                            }
                            break;
                        default :
                            //无趣的扩展
                            skip();
                    }
                    break;
                case 0x3b :
                    // 结束
                    done = true;
                    break;
                case 0x00 :
                    //坏字节，但是继续前进，看看会发生什么
                    break;
                default :
                    status = STATUS_FORMAT_ERROR;
            }
        }
    }
    /**
     * 读取图形控件扩展值
     */
    protected void readGraphicControlExt() {
        //块大小
        read();
        //打包的字段
        int packed = read();
        //处理方法
        dispose = (packed & 0x1c) >> 2;
        if (dispose == 0) {
            //选择酌情保留旧形象
            dispose = 1;
        }
        transparency = (packed & 1) != 0;
        //延迟毫秒
        delay = readShort() * 10;
        //透明色指数
        transIndex = read();
        //终止块
        read();
    }
    /**
     * 读取GIF文件头信息。
     */
    protected void readHeader() {
        StringBuilder id = new StringBuilder();
        for (int i = 0; i < 6; i++) {
            id.append((char) read());
        }
        if (!id.toString().startsWith(GIF_STR)) {
            status = STATUS_FORMAT_ERROR;
            return;
        }
        readLSD();
        if (gctFlag && !err()) {
            gct = readColorTable(gctSize);
            bgColor = gct[bgIndex];
        }
    }
    /**
     * 读取下一帧图像
     */
    protected void readImage() {
        // （子）图像位置和大小
        ix = readShort();
        iy = readShort();
        iw = readShort();
        ih = readShort();
        int packed = read();
        // 1 - 本地颜色表标志
        lctFlag = (packed & 0x80) != 0;
        // 2 - 隔行标志
        interlace = (packed & 0x40) != 0;
        // 3 - 排序标志
        // 4-5 - 保留的
        // 6-8 - 本地色表大小
        lctSize = 2 << (packed & 7);
        if (lctFlag) {
            //读表
            lct = readColorTable(lctSize);
            //使本地表处于活动状态
            act = lct;
        } else {
            //使全局表处于活动状态
            act = gct;
            if (bgIndex == transIndex) {
                bgColor = 0;
            }
        }
        int save = 0;
        if (transparency) {
            save = act[transIndex];
            //设置透明颜色（如果指定）
            act[transIndex] = 0;
        }
        if (act == null) {
            //未定义颜色表
            status = STATUS_FORMAT_ERROR;
        }
        if (err()) { return; }

        //解码像素数据
        decodeImageData();
        skip();
        if (err()) { return; }

        frameCount++;
        //创建新图像以接收帧数据
        image = new BufferedImage(width, height, BufferedImage.TYPE_INT_ARGB_PRE);
        //将像素数据传输到图像
        setPixels();
        //将图像添加到框架列表
        frames.add(new GifFrame(image, delay));
        if (transparency) {
            act[transIndex] = save;
        }
        resetFrame();
    }
    /**
     * 读取逻辑屏幕描述符
     */
    protected void readLSD() {
        //逻辑屏幕尺寸
        width = readShort();
        height = readShort();
        //打包的字段
        int packed = read();
        // 1   : 全局颜色表标志
        gctFlag = (packed & 0x80) != 0;
        // 2-4 : 颜色分辨率
        // 5   : gct排序标志
        // 6-8 : gct 大小
        gctSize = 2 << (packed & 7);
        // 背景色指数
        bgIndex = read();
        // 像素长宽比
        pixelAspect = read();
    }

    /**
     * 读取Netscape扩展以获得迭代计数
     */
    protected void readNetscapeExt() {
        do {
            readBlock();
            if (block[0] == 1) {
                // 循环计数子块
                int b1 = ((int) block[1]) & 0xff;
                int b2 = ((int) block[2]) & 0xff;
                loopCount = (b2 << 8) | b1;
            }
        } while ((blockSize > 0) && !err());
    }
    /**
     * 读取下一个16位值，先读取LSB
     */
    protected int readShort() { return read() | (read() << 8); }
    /**
     * 重置帧状态以读取下一个图像。
     */
    protected void resetFrame() {
        lastDispose = dispose;
        lastRect = new Rectangle(ix, iy, iw, ih);
        lastImage = image;
        lastBgColor = bgColor;
        lct = null;
    }
    protected void skip() { do { readBlock(); } while ((blockSize > 0) && !err()); }
}
